+ NEW PROJECT REQUEST DEMO
Explore Products Industries API
Menu
plotly is free for unlimited public use
SIGN UP FOR FREE
Sensitive data? Upgrade to a paid plan or trial plotly offline

API Libraries/MATLAB/

Fork on GitHub

matlab figure reference

fig2plotly converts MATLAB figures to online Plotly graphs. MATLAB describes figures differently than Plotly. Plotly's MATLAB library crawls the MATLAB figure objects and translates the MATLAB attributes into the structure that Plotly uses to describe and draw data visualizations.

You may wish to customize the figure after you have translated it but before you have sent it to Plotly. You can customize every attribute of a plotly graph: the hover text, the colorscales, the gridlines, the histogram binning, etc.

plotly charts are described declaritively with struct and cell array objects. This page contains an extensive list of the keys used to describe plotly graphs inside these struct objects. Here is a simple example of how to translate a MATLAB figure, modify some attributes, and then send it to Plotly. 

>> x = linspace(-2*pi, 2*pi);
>> y1 = sin(x);
>> y2 = cos(x);
>> plot(x, y1, x, y2);

%% Translate the figure from MATLAB to Plotly
>> fig = plotlyfig(gcf);

>> fig.PlotOptions.Strip = 0; % If 0, don't strip MATLAB's styling in translation. If 1, strip MATLAB's styling.

>> fig.data
ans =

   [1x1 struct]    [1x1 struct]

>> fig.data{1}    % The 'type' of this trace is 'scatter'. scatter's reference: #scatter
ans =

        xaxis: 'x1'             % more about scatter's 'xaxis': #scatter-xaxis
        yaxis: 'y1'             % scatter's 'yaxis' property:   #scatter-yaxis
         type: 'scatter'
      visible: 1                % scatter's 'visible' property: #scatter-visible
            x: [1x100 double]   % scatter's 'x' property:       #scatter-x
            y: [1x100 double]   % scatter's 'y' property:       #scatter-y
         name: ''               % scatter's 'name' property:    #scatter-name
         mode: 'lines'          % scatter's 'mode' property:    #scatter-mode
         line: [1x1 struct]     % scatter's 'line' property:    #scatter-line
       marker: [1x1 struct]     % scatter's 'marker' property:  #scatter-marker
   showlegend: 1                % scatter's 'showlegend':       #scatter-marker

%% Modify or add new properties to this trace
>> fig.data{1}.name = 'Current'; % Update the legend name to 'Current'

>> fig.layout     % layout reference: #layout
ans =

        autosize: 0                     % layout's 'autosize':      #layout-autosize
          margin: [1x1 struct]          % layout's 'margin':        #layout-margin
      showlegend: 0                     % layout's 'showlegend':    #layout-showlegend
           width: 840                   % layout's 'width':         #layout-width
          height: 630                   % layout's 'height':        #layout-height
   paper_bgcolor: 'rgb(255,255,255)'    % layout's 'paper_bgcolor': #layout-paper_bgcolor
       hovermode: 'closest'             % layout's 'hovermode':     #layout-hovermode
    plot_bgcolor: 'rgba(0,0,0,0)'       % layout's 'plot_bgcolor':  #layout-plot_bgcolor
          xaxis1: [1x1 struct]          % layout's 'xaxis':         #layout-xaxis
          yaxis1: [1x1 struct]          % layout's 'yaxis':         #layout-yaxis
     annotations: {[1x1 struct]}        % layout's 'annotations':   #layout-annotations

>> fig.layout.showlegend = true;  % layout's 'showlegend':    #layout-showlegend
>> fig.layout.legend = struct('x', 1, 'y', 1); % Update the legend: #layout-legend
>> fig.layout.title = 'Modified plot';

%% Set the filename, and overwrite the plot if it already exists
>> fig.PlotOptions.FileName = 'Customized plot';
>> fig.PlotOptions.FileOpt = 'overwrite';
>> % using offline? Then set fig.PlotOptions.Offline = true;

%% Send to plotly
>> fig.plotly

scatter

bar

box

heatmap

histogram

histogram2d

pie

contour

histogram2dcontour

scatter3d

surface

mesh3d

scattergeo

choropleth

area

layout

scatter
A scatter trace is a struct inside fig.data which has type equal to 'scatter'. This section lists all of the valid keys that a scatter struct can contain.

The data visualized as scatter point or lines is set in `x` and `y` Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.

  • type ('scatter')
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • mode (flaglist)
    flags: 'lines' | 'markers' | 'text'
    extras: 'none'
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.
  • line (struct)
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • shape (enumerated: 'linear' | 'spline' | 'hv' | 'vh' | 'hvh' | 'vhv' )
      default: 'linear'
      Determines the line shape. With 'spline' the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Has only an effect if `shape` is set to 'spline' Sets the amount of smoothing. '0' corresponds to no smoothing (equivalent to a 'linear' shape).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • fill (enumerated: 'none' | 'tozeroy' | 'tozerox' | 'tonexty' | 'tonextx' )
    default: 'none'
    Sets the area to fill with a solid color. Use with `fillcolor`.
  • fillcolor (color)
    Sets the fill color.
  • marker (struct)
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets the marker color.
    • maxdisplayed (number greater than or equal to 0)
      default: 0
      Sets a maximum number of points to be drawn on the graph. '0' corresponds to no limit.
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'middle center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont (struct)
    Sets the text font.
    • family (string)
    • size (number greater than or equal to 1)
    • color (color)
    • familysrc (string)
      Sets the source reference on plot.ly for family .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .

bar
A bar trace is a struct inside fig.data which has type equal to 'bar'. This section lists all of the valid keys that a bar struct can contain.

The data visualized by the span of the bars is set in `y` if `orientation` is set th 'v' (the default) and the labels are set in `x`. By setting `orientation` to 'h', the roles are interchanged.

  • type ('bar')
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • marker (struct)
    • color (color)
      Sets the marker color.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • _deprecated
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .

box
A box trace is a struct inside fig.data which has type equal to 'box'. This section lists all of the valid keys that a box struct can contain.

In vertical (horizontal) box plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one box per distinct x (y) value is drawn If no `x` (`y`) cell array is provided, a single box is drawn. That box position is then positioned with with `name` or with `x0` (`y0`) if provided. Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2) is marked by a line inside the box. By default, the whiskers correspond to the box' edges +/- 1.5 times the interquartile range (IQR = Q3-Q1), see 'boxpoints' for other options.

  • type ('box')
  • y (array)
    Sets the y sample data or coordinates. See overview for more info.
  • x (array)
    Sets the x sample data or coordinates. See overview for more info.
  • x0 (any)
    Sets the x coordinate of the box. See overview for more info.
  • y0 (any)
    Sets the y coordinate of the box. See overview for more info.
  • whiskerwidth (number between or equal to 0 and 1)
    default: 0.5
    Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
  • boxpoints (enumerated: 'all' | 'outliers' | 'suspectedoutliers' | false )
    default: 'outliers'
    If 'outliers', only the sample points lying outside the whiskers are shown If 'suspectedoutliers', the outlier points are shown and points either less than 4'Q1-3'Q3 or greater than 4'Q3-3'Q1 are highlighted (see `outliercolor`) If 'all', all sample points are shown If 'false', only the box(es) are shown with no sample points
  • boxmean (enumerated: true | 'sd' | false )
    If 'true', the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If 'sd' the standard deviation is also drawn.
  • jitter (number between or equal to 0 and 1)
    Sets the amount of jitter in the sample points drawn. If '0', the sample points align along the distribution axis. If '1', the sample points are drawn in a random jitter of width equal to the width of the box(es).
  • pointpos (number between or equal to -2 and 2)
    Sets the position of the sample points in relation to the box(es). If '0', the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the box(es). If 'v' ('h'), the distribution is visualized along the vertical (horizontal).
  • marker (struct)
    • outliercolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of the outlier sample points.
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets the marker color.
    • line (struct)
      • color (color)
        default: '#444'
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • outliercolor (color)
        Sets the border line color of the outlier sample points.
      • outlierwidth (number greater than or equal to 0)
        default: 1
        Sets the border line width (in px) of the outlier sample points.
  • line (struct)
    • color (color)
      Sets the color of line bounding the box(es).
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the box(es).
  • fillcolor (color)
    Sets the fill color.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • xsrc (string)
    Sets the source reference on plot.ly for x .

heatmap
A heatmap trace is a struct inside fig.data which has type equal to 'heatmap'. This section lists all of the valid keys that a heatmap struct can contain.

The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a matrix of values (ragged or not) or a 1D array of values. In the case where `z` is a matrix, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D cell array, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets.

  • type ('heatmap')
  • z (array)
    Sets the z data.
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

histogram
A histogram trace is a struct inside fig.data which has type equal to 'histogram'. This section lists all of the valid keys that a histogram struct can contain.

The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided.

  • type ('histogram')
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • marker (struct)
    • color (array)
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • z (array)
    Sets the aggregation data.
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins (struct)
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins (struct)
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each y axis bin.
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • _deprecated
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .
  • zsrc (string)
    Sets the source reference on plot.ly for z .

histogram2d
A histogram2d trace is a struct inside fig.data which has type equal to 'histogram2d'. This section lists all of the valid keys that a histogram2d struct can contain.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a heatmap.

  • type ('histogram2d')
  • z (array)
    Sets the aggregation data.
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • marker (struct)
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins (struct)
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins (struct)
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each y axis bin.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

pie
A pie trace is a struct inside fig.data which has type equal to 'pie'. This section lists all of the valid keys that a pie struct can contain.

A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`

  • type ('pie')
  • labels (array)
    Sets the sector labels.
  • label0 (number)
    default: 0
    Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
  • dlabel (number)
    default: 1
    Sets the label step. See `label0` for more info.
  • marker (struct)
    • colors (array)
      Sets the color of each sector of this pie chart. If not specified, the default trace color set is used to pick the sector colors.
    • line (struct)
      • color (color)
        default: '#444'
        Sets the color of the line enclosing each sector.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the line enclosing each sector.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorssrc (string)
      Sets the source reference on plot.ly for colors .
  • text (array)
    Sets text elements associated with each sector.
  • scalegroup (string)
    default: ''
    If there are multiple pies that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
  • textinfo (flaglist)
    flags: 'label' | 'text' | 'value' | 'percent'
    extras: 'none'
    examples: 'label', 'text', 'label+text', 'label+text+value', 'none'
    Determines which trace information appear on the graph.
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • textposition (enumerated: 'inside' | 'outside' | 'auto' | 'none' )
    default: 'auto'
    Specifies the location of the `textinfo`.
  • textfont (struct)
    Sets the font used for `textinfo`.
  • insidetextfont (struct)
    Sets the font used for `textinfo` lying inside the pie.
  • outsidetextfont (struct)
    Sets the font used for `textinfo` lying outside the pie.
  • domain (struct)
    • x (cell array)
      default: [0, 1]
      Sets the horizontal domain of this pie trace (in plot fraction).
    • y (cell array)
      default: [0, 1]
      Sets the vertical domain of this pie trace (in plot fraction).
  • hole (number between or equal to 0 and 1)
    default: 0
    Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.
  • sort (boolean)
    default: true
    Determines whether or not the sectors of reordered from largest to smallest.
  • direction (enumerated: 'clockwise' | 'counterclockwise' )
    default: 'counterclockwise'
    Specifies the direction at which succeeding sectors follow one another.
  • rotation (number between or equal to -360 and 360)
    default: 0
    Instead of the first slice starting at 12 o'clock, rotate to some other angle.
  • pull (number between or equal to 0 and 1)
    default: 0
    Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • labelssrc (string)
    Sets the source reference on plot.ly for labels .
  • valuessrc (string)
    Sets the source reference on plot.ly for values .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .
  • pullsrc (string)
    Sets the source reference on plot.ly for pull .

contour
A contour trace is a struct inside fig.data which has type equal to 'contour'. This section lists all of the valid keys that a contour struct can contain.

The data from which contour lines are computed is set in `z`. Data in `z` must be a matrix of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto-generated). By setting `transpose` to 'true', the above behavior is flipped.

  • type ('contour')
  • z (array)
    Sets the z data.
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • autocontour (boolean)
    default: true
    Determines whether of not the contour level attributes at picked by an algorithm. If 'true', the number of contour levels can be set in `ncontours`. If 'false', set the contour level attributes in `contours`.
  • ncontours (integer)
    default: 0
    Sets the number of contour levels.
  • contours (struct)
    • start (number)
      Sets the starting contour level value.
    • end (number)
      Sets the end contour level value.
    • size (number)
      Sets the step between each contour level.
    • coloring (enumerated: 'fill' | 'heatmap' | 'lines' | 'none' )
      default: 'fill'
      Determines the coloring method showing the contour values. If 'fill', coloring is done evenly between each contour level If 'heatmap', a heatmap gradient is coloring is applied between each contour level. If 'lines', coloring is done on the contour lines. If 'none', no coloring is applied on this trace.
    • showlines (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has only an effect if `contours.coloring` is set to 'fill'.
  • line (struct)
    • color (color)
      Sets the color of the contour level. Has no if `contours.coloring` is set to 'lines'.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where '0' corresponds to no smoothing.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

histogram2dcontour
A histogram2dcontour trace is a struct inside fig.data which has type equal to 'histogram2dcontour'. This section lists all of the valid keys that a histogram2dcontour struct can contain.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot.

  • type ('histogram2dcontour')
  • z (array)
    Sets the aggregation data.
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • marker (struct)
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins (struct)
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins (struct)
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each y axis bin.
  • autocontour (boolean)
    default: true
    Determines whether of not the contour level attributes at picked by an algorithm. If 'true', the number of contour levels can be set in `ncontours`. If 'false', set the contour level attributes in `contours`.
  • ncontours (integer)
    default: 0
    Sets the number of contour levels.
  • contours (struct)
    • start (number)
      Sets the starting contour level value.
    • end (number)
      Sets the end contour level value.
    • size (number)
      Sets the step between each contour level.
    • coloring (enumerated: 'fill' | 'heatmap' | 'lines' | 'none' )
      default: 'fill'
      Determines the coloring method showing the contour values. If 'fill', coloring is done evenly between each contour level If 'heatmap', a heatmap gradient is coloring is applied between each contour level. If 'lines', coloring is done on the contour lines. If 'none', no coloring is applied on this trace.
    • showlines (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has only an effect if `contours.coloring` is set to 'fill'.
  • line (struct)
    • color (color)
      Sets the color of the contour level. Has no if `contours.coloring` is set to 'lines'.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where '0' corresponds to no smoothing.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

scatter3d
A scatter3d trace is a struct inside fig.data which has type equal to 'scatter3d'. This section lists all of the valid keys that a scatter3d struct can contain.

The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.

  • type ('scatter3d')
  • x (array)
    Sets the x coordinates.
  • y (array)
    Sets the y coordinates.
  • z (array)
    Sets the z coordinates.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates.
  • mode (flaglist)
    flags: 'lines' | 'markers' | 'text'
    default: lines+markers
    extras: 'none'
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.
  • surfaceaxis (enumerated: '-1' | '0' | '1' | '2' )
    default: '-1'
    If '-1', the scatter points are not fill with a surface If '0', '1', '2', the scatter points are filled with a Delaunay surface about the x, y, z respectively.
  • surfacecolor (color)
    Sets the surface fill color.
  • projection (struct)
    • x (struct)
      • show (boolean)
        Sets whether or not projections are shown along the x axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • y (struct)
      • show (boolean)
        Sets whether or not projections are shown along the y axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • z (struct)
      • show (boolean)
        Sets whether or not projections are shown along the z axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
  • line (struct)
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
  • marker (struct)
    • color (color)
      Sets the marker color.
    • symbol (enumerated: 'circle' | 'circle-open' | 'square' | 'square-open' | 'diamond' | 'diamond-open' | 'cross' | 'x' )
      default: 'circle'
      Sets the marker symbol type.
    • size (number greater than or equal to 0)
      default: 8
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'top center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont (struct)
    Sets the text font.
    • family (string)
    • size (number greater than or equal to 1)
    • color (color)
    • familysrc (string)
      Sets the source reference on plot.ly for family .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_z (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .

surface
A surface trace is a struct inside fig.data which has type equal to 'surface'. This section lists all of the valid keys that a surface struct can contain.

The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a matrix. Coordinates in `x` and `y` can either be 1D cell arrays or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step.

  • type ('surface')
  • z (array)
    Sets the z coordinates.
  • x (array)
    Sets the x coordinates.
  • y (array)
    Sets the y coordinates.
  • text (array)
    Sets the text elements associated with each z value.
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • contours (struct)
    • x (struct)
      • show (boolean)
        Sets whether or not dynamic contours are shown along the x axis
      • project (struct)
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
    • y (struct)
      • show (boolean)
        Sets whether or not dynamic contours are shown along the y axis
      • project (struct)
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
    • z (struct)
      • show (boolean)
        Sets whether or not dynamic contours are shown along the z axis
      • project (struct)
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
  • hidesurface (boolean)
  • lighting (struct)
    • ambient (number between or equal to 0 and 1)
      default: 0.8
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
    • specular (number between or equal to 0 and 2)
      default: 0.05
    • roughness (number between or equal to 0 and 1)
      default: 0.5
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

mesh3d
A mesh3d trace is a struct inside fig.data which has type equal to 'mesh3d'. This section lists all of the valid keys that a mesh3d struct can contain.



  • type ('mesh3d')
  • x (array)
  • y (array)
  • z (array)
  • i (array)
  • j (array)
  • k (array)
  • delaunayaxis (enumerated: 'x' | 'y' | 'z' )
    default: 'z'
  • alphahull (number)
    default: -1
  • intensity (array)
  • color (color)
  • vertexcolor (array)
  • facecolor (array)
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • flatshading (boolean)
  • contour (struct)
    • show (boolean)
    • color (color)
      default: '#000'
    • width (number between or equal to 1 and 16)
      default: 2
  • colorscale (colorscale)
    Sets the colorscale.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • lighting (struct)
    • ambient (number between or equal to 0 and 1)
      default: 0.8
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
    • specular (number between or equal to 0 and 2)
      default: 0.05
    • roughness (number between or equal to 0 and 1)
      default: 0.5
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • isrc (string)
    Sets the source reference on plot.ly for i .
  • jsrc (string)
    Sets the source reference on plot.ly for j .
  • ksrc (string)
    Sets the source reference on plot.ly for k .
  • intensitysrc (string)
    Sets the source reference on plot.ly for intensity .
  • vertexcolorsrc (string)
    Sets the source reference on plot.ly for vertexcolor .
  • facecolorsrc (string)
    Sets the source reference on plot.ly for facecolor .

scattergeo
A scattergeo trace is a struct inside fig.data which has type equal to 'scattergeo'. This section lists all of the valid keys that a scattergeo struct can contain.

The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in `lon` and `lat` respectively or by geographic location IDs or names in `locations`.

  • type ('scattergeo')
  • lon (array)
    Sets the longitude coordinates (in degrees East).
  • lat (array)
    Sets the latitude coordinates (in degrees North).
  • locations (array)
    Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.
  • locationmode (enumerated: 'ISO-3' | 'USA-states' | 'country names' )
    default: 'ISO-3'
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • mode (flaglist)
    flags: 'lines' | 'markers' | 'text'
    default: markers
    extras: 'none'
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.
  • text (string)
    default: ''
    Sets text elements associated with each (lon,lat) pair. or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates.
  • line (struct)
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
  • marker (struct)
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • color (color)
      Sets the marker color.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • textfont (struct)
    Sets the text font.
    • family (string)
    • size (number greater than or equal to 1)
    • color (color)
    • familysrc (string)
      Sets the source reference on plot.ly for family .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'middle center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • geo (geoid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If 'geo' (the default value), the geospatial coordinates refer to `layout.geo`. If 'geo2', the geospatial coordinates refer to `layout.geo2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • lonsrc (string)
    Sets the source reference on plot.ly for lon .
  • latsrc (string)
    Sets the source reference on plot.ly for lat .
  • locationssrc (string)
    Sets the source reference on plot.ly for locations .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .

choropleth
A choropleth trace is a struct inside fig.data which has type equal to 'choropleth'. This section lists all of the valid keys that a choropleth struct can contain.

The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`.

  • type ('choropleth')
  • locations (array)
    Sets the coordinates via location IDs or names. See `locationmode` for more info.
  • locationmode (enumerated: 'ISO-3' | 'USA-states' | 'country names' )
    default: 'ISO-3'
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • z (array)
    Sets the color values.
  • text (array)
    Sets the text elements associated with each location.
  • marker (struct)
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    default: true
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • geo (geoid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If 'geo' (the default value), the geospatial coordinates refer to `layout.geo`. If 'geo2', the geospatial coordinates refer to `layout.geo2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • locationssrc (string)
    Sets the source reference on plot.ly for locations .
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

area
A area trace is a struct inside fig.data which has type equal to 'area'. This section lists all of the valid keys that a area struct can contain.



  • type ('area')
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • marker (struct)
    • color (color)
      Sets the marker color.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .

layout
  • font (struct)
    Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
    • family (string)
      default: '"Open sans", verdana, arial, sans-serif'
    • size (number greater than or equal to 1)
      default: 12
    • color (color)
      default: '#444'
  • title (string)
    default: 'Click to enter Plot title'
    Sets the plot's title.
  • titlefont (struct)
    Sets the title font.
  • autosize (enumerated: true | false | 'initial' )
    Determines whether or not the dimensions of the figure are computed as a function of the display size.
  • width (number greater than or equal to 10)
    default: 700
    Sets the plot's width (in px).
  • height (number greater than or equal to 10)
    default: 450
    Sets the plot's height (in px).
  • margin (struct)
    • l (number greater than or equal to 0)
      default: 80
      Sets the left margin (in px).
    • r (number greater than or equal to 0)
      default: 80
      Sets the right margin (in px).
    • t (number greater than or equal to 0)
      default: 100
      Sets the top margin (in px).
    • b (number greater than or equal to 0)
      default: 80
      Sets the bottom margin (in px).
    • pad (number greater than or equal to 0)
      default: 0
      Sets the amount of padding (in px) between the plotting area and the axis lines
    • autoexpand (boolean)
      default: true
  • paper_bgcolor (color)
    default: '#fff'
    Sets the color of paper where the graph is drawn.
  • plot_bgcolor (color)
    default: '#fff'
    Sets the color of plotting area in-between x and y axes.
  • separators (string)
    default: '.,'
    Sets the decimal and thousand separators. For example, '. ' puts a '.' before decimals and a space between thousands.
  • hidesources (boolean)
    Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the plotly cloud.
  • smith (enumerated: false )
  • showlegend (boolean)
    Determines whether or not a legend is drawn.
  • dragmode (enumerated: 'zoom' | 'pan' | 'orbit' | 'turntable' )
    Determines the mode of drag interactions.
  • hovermode (enumerated: 'x' | 'y' | 'closest' | false )
    Determines the mode of hover interactions.
  • xaxis (struct)
    • title (string)
      Sets the title of this axis.
    • titlefont (struct)
      Sets this axis' title font.
    • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
      default: '-'
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange (enumerated: true | false | 'reversed' )
      default: true
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
    • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
      default: 'normal'
      If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
    • range (cell array)
      Sets the range of this axis.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
      Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • hoverformat (string)
      default: ''
      Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: '#444'
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
    • gridcolor (color)
      default: '#eee'
      Sets the color of the grid lines.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • zeroline (boolean)
      Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
    • zerolinecolor (color)
      default: '#444'
      Sets the line color of the zero line.
    • zerolinewidth (number)
      default: 1
      Sets the width (in px) of the zero line.
    • anchor (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set to an opposite-letter axis id (e.g. `xaxis2`, `yaxis`), this axis is bound to the corresponding opposite-letter axis. If set to 'free', this axis' position is determined by `position`.
    • side (enumerated: 'top' | 'bottom' | 'left' | 'right' )
      Determines whether a x (y) axis is positioned at the 'bottom' ('left') or 'top' ('right') of the plotting area.
    • overlaying (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis. If 'false', this axis does not overlay any same-letter axes.
    • domain (cell array)
      default: [0, 1]
      Sets the domain of this axis (in plot fraction).
    • position (number between or equal to 0 and 1)
      default: 0
      Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to 'free'.
    • _deprecated
    • _isSubplotObj
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • yaxis (struct)
    • title (string)
      Sets the title of this axis.
    • titlefont (struct)
      Sets this axis' title font.
    • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
      default: '-'
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange (enumerated: true | false | 'reversed' )
      default: true
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
    • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
      default: 'normal'
      If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
    • range (cell array)
      Sets the range of this axis.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
      Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • hoverformat (string)
      default: ''
      Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: '#444'
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
    • gridcolor (color)
      default: '#eee'
      Sets the color of the grid lines.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • zeroline (boolean)
      Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
    • zerolinecolor (color)
      default: '#444'
      Sets the line color of the zero line.
    • zerolinewidth (number)
      default: 1
      Sets the width (in px) of the zero line.
    • anchor (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set to an opposite-letter axis id (e.g. `xaxis2`, `yaxis`), this axis is bound to the corresponding opposite-letter axis. If set to 'free', this axis' position is determined by `position`.
    • side (enumerated: 'top' | 'bottom' | 'left' | 'right' )
      Determines whether a x (y) axis is positioned at the 'bottom' ('left') or 'top' ('right') of the plotting area.
    • overlaying (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis. If 'false', this axis does not overlay any same-letter axes.
    • domain (cell array)
      default: [0, 1]
      Sets the domain of this axis (in plot fraction).
    • position (number between or equal to 0 and 1)
      default: 0
      Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to 'free'.
    • _deprecated
    • _isSubplotObj
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • scene (struct)
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
    • camera (struct)
      • up (struct)
        Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene with respect to the page. The default is '{x: 0, y: 0, z: 1}' which means that the z axis points up.
        • x (number)
          default: 0
        • y (number)
          default: 0
        • z (number)
          default: 1
      • center (struct)
        Sets the (x,y,z) components of the 'center' camera vector This vector determines the translation (x,y,z) space about the center of this scene. By default, there is no such translation.
        • x (number)
          default: 0
        • y (number)
          default: 0
        • z (number)
          default: 0
      • eye (struct)
        Sets the (x,y,z) components of the 'eye' camera vector. This vector determines the view point about the origin of this scene.
        • x (number)
          default: 1.25
        • y (number)
          default: 1.25
        • z (number)
          default: 1.25
    • domain (struct)
      • x (cell array)
        default: [0, 1]
        Sets the horizontal domain of this scene (in plot fraction).
      • y (cell array)
        default: [0, 1]
        Sets the vertical domain of this scene (in plot fraction).
    • aspectmode (enumerated: 'auto' | 'cube' | 'data' | 'manual' )
      default: 'auto'
      If 'cube', this scene's axes are drawn as a cube, regardless of the axes' ranges. If 'data', this scene's axes are drawn in proportion with the axes' ranges. If 'manual', this scene's axes are drawn in proportion with the input of 'aspectratio' (the default behavior if 'aspectratio' is provided). If 'auto', this scene's axes are drawn using the results of 'data' except when one axis is more than four times the size of the two others, where in that case the results of 'cube' are used.
    • aspectratio (struct)
      Sets this scene's axis aspectratio.
      • x (number greater than or equal to 0)
      • y (number greater than or equal to 0)
      • z (number greater than or equal to 0)
    • xaxis (struct)
      • showspikes (boolean)
        default: true
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: true
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: 'rgb(0,0,0)'
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: 'rgba(204, 204, 204, 0.5)'
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: true
        Sets whether or not this axis is labeled
      • title (string)
        Sets the title of this axis.
      • titlefont (struct)
        Sets this axis' title font.
      • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
        default: '-'
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange (enumerated: true | false | 'reversed' )
        default: true
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
      • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
        default: 'normal'
        If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
      • range (cell array)
        Sets the range of this axis.
      • fixedrange (boolean)
        Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • hoverformat (string)
        default: ''
        Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: '#444'
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: 'rgb(204, 204, 204)'
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: '#444'
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • yaxis (struct)
      • showspikes (boolean)
        default: true
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: true
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: 'rgb(0,0,0)'
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: 'rgba(204, 204, 204, 0.5)'
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: true
        Sets whether or not this axis is labeled
      • title (string)
        Sets the title of this axis.
      • titlefont (struct)
        Sets this axis' title font.
      • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
        default: '-'
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange (enumerated: true | false | 'reversed' )
        default: true
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
      • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
        default: 'normal'
        If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
      • range (cell array)
        Sets the range of this axis.
      • fixedrange (boolean)
        Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • hoverformat (string)
        default: ''
        Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: '#444'
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: 'rgb(204, 204, 204)'
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: '#444'
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • zaxis (struct)
      • showspikes (boolean)
        default: true
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: true
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: 'rgb(0,0,0)'
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: 'rgba(204, 204, 204, 0.5)'
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: true
        Sets whether or not this axis is labeled
      • title (string)
        Sets the title of this axis.
      • titlefont (struct)
        Sets this axis' title font.
      • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
        default: '-'
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange (enumerated: true | false | 'reversed' )
        default: true
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
      • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
        default: 'normal'
        If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
      • range (cell array)
        Sets the range of this axis.
      • fixedrange (boolean)
        Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • hoverformat (string)
        default: ''
        Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: '#444'
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: 'rgb(204, 204, 204)'
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: '#444'
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • _deprecated
    • _isSubplotObj
  • geo (struct)
    • domain (struct)
      • x (cell array)
        default: [0, 1]
        Sets the horizontal domain of this map (in plot fraction).
      • y (cell array)
        default: [0, 1]
        Sets the vertical domain of this map (in plot fraction).
    • resolution (enumerated: '110' | '50' )
      default: '110'
      Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.
    • scope (enumerated: 'world' | 'usa' | 'europe' | 'asia' | 'africa' | 'north america' | 'south america' )
      default: 'world'
      Set the scope of the map.
    • projection (struct)
      • type (enumerated: 'equirectangular' | 'mercator' | 'orthographic' | 'natural earth' | 'kavrayskiy7' | 'miller' | 'robinson' | 'eckert4' | 'azimuthal equal area' | 'azimuthal equidistant' | 'conic equal area' | 'conic conformal' | 'conic equidistant' | 'gnomonic' | 'stereographic' | 'mollweide' | 'hammer' | 'transverse mercator' | 'albers usa' )
        Sets the projection type.
      • rotation (struct)
        • lon (number)
          Rotates the map along parallels (in degrees East).
        • lat (number)
          Rotates the map along meridians (in degrees North).
        • roll (number)
          Roll the map (in degrees) For example, a roll of '180' makes the map appear upside down.
      • parallels (cell array)
        For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere.
      • scale (number between or equal to 0 and 10)
        default: 1
        Zooms in or out on the map view.
    • showcoastlines (boolean)
      Sets whether or not the coastlines are drawn.
    • coastlinecolor (color)
      default: '#444'
      Sets the coastline color.
    • coastlinewidth (number greater than or equal to 0)
      default: 1
      Sets the coastline stroke width (in px).
    • showland (boolean)
      Sets whether or not land masses are filled in color.
    • landcolor (color)
      default: '#F0DC82'
      Sets the land mass color.
    • showocean (boolean)
      Sets whether or not oceans are filled in color.
    • oceancolor (color)
      default: '#3399FF'
      Sets the ocean color
    • showlakes (boolean)
      Sets whether or not lakes are drawn.
    • lakecolor (color)
      default: '#3399FF'
      Sets the color of the lakes.
    • showrivers (boolean)
      Sets whether or not rivers are drawn.
    • rivercolor (color)
      default: '#3399FF'
      Sets color of the rivers.
    • riverwidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the rivers.
    • showcountries (boolean)
      Sets whether or not country boundaries are drawn.
    • countrycolor (color)
      default: '#444'
      Sets line color of the country boundaries.
    • countrywidth (number greater than or equal to 0)
      default: 1
      Sets line width (in px) of the country boundaries.
    • showsubunits (boolean)
      Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.
    • subunitcolor (color)
      default: '#444'
      Sets the color of the subunits boundaries.
    • subunitwidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the subunits boundaries.
    • showframe (boolean)
      Sets whether or not a frame is drawn around the map.
    • framecolor (color)
      default: '#444'
      Sets the color the frame.
    • framewidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the frame.
    • bgcolor (color)
      default: '#fff'
      Set the background color of the map
    • lonaxis (struct)
      • range (cell array)
        Sets the range of this axis (in degrees).
      • showgrid (boolean)
        Sets whether or not graticule are shown on the map.
      • tick0 (number)
        Sets the graticule's starting tick longitude/latitude.
      • dtick (number)
        Sets the graticule's longitude/latitude tick step.
      • gridcolor (color)
        default: '#eee'
        Sets the graticule's stroke color.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the graticule's stroke width (in px).
    • lataxis (struct)
      • range (cell array)
        Sets the range of this axis (in degrees).
      • showgrid (boolean)
        Sets whether or not graticule are shown on the map.
      • tick0 (number)
        Sets the graticule's starting tick longitude/latitude.
      • dtick (number)
        Sets the graticule's longitude/latitude tick step.
      • gridcolor (color)
        default: '#eee'
        Sets the graticule's stroke color.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the graticule's stroke width (in px).
    • _isSubplotObj
  • legend (struct)
    • bgcolor (color)
      Sets the legend background color.
    • bordercolor (color)
      default: '#444'
      Sets the color of the border enclosing the legend.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) of the border enclosing the legend.
    • font (struct)
      Sets the font used to text the legend items.
    • traceorder (flaglist)
      flags: 'reversed' | 'grouped'
      extras: 'normal'
      examples: 'reversed', 'grouped', 'reversed+grouped', 'normal'
      Determines the order at which the legend items are displayed. If 'normal', the items are displayed top-to-bottom in the same order as the input data. If 'reversed', the items are displayed in the opposite order as 'normal'. If 'grouped', the items are displayed in groups (when a trace `legendgroup` is provided). if 'grouped+reversed', the items are displayed in the opposite order as 'grouped'.
    • tracegroupgap (number greater than or equal to 0)
      default: 10
      Sets the amount of vertical space (in px) between legend groups.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position (in normalized coordinates) of the legend.
    • xanchor (enumerated: 'auto' | 'left' | 'center' | 'right' )
      default: 'left'
      Sets the legend's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the legend.
    • y (number between or equal to -2 and 3)
      default: 1
      Sets the y position (in normalized coordinates) of the legend.
    • yanchor (enumerated: 'auto' | 'top' | 'middle' | 'bottom' )
      default: 'auto'
      Sets the legend's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the legend.
  • annotations (cell array of structs)
    • text (string)
      Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.
    • textangle (angle)
      default: 0
      Sets the angle at which the `text` is drawn with respect to the horizontal.
    • font (struct)
      Sets the annotation text font.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the opacity of the annotation (text + arrow).
    • align (enumerated: 'left' | 'center' | 'right' )
      default: 'center'
      Sets the vertical alignment of the `text` with respect to the set `x` and `y` position. Has only an effect if `text` spans more two or more lines (i.e. `text` contains one or more <br> HTML tags).
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the background color of the annotation.
    • bordercolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of the border enclosing the annotation `text`.
    • borderpad (number greater than or equal to 0)
      default: 1
      Sets the padding (in px) between the `text` and the enclosing border.
    • borderwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the border enclosing the annotation `text`.
    • showarrow (boolean)
      default: true
      Determines whether or not the annotation is drawn with an arrow. If 'true', `text` is placed near the arrow's tail. If 'false', `text` lines up with the `x` and `y` provided.
    • arrowcolor (color)
      Sets the color of the annotation arrow.
    • arrowhead (integer between or equal to 0 and 8)
      default: 1
      Sets the annotation arrow head style.
    • arrowsize (number greater than or equal to 0.3)
      default: 1
      Sets the size (in px) of annotation arrow head.
    • arrowwidth (number greater than or equal to 0.1)
      Sets the width (in px) of annotation arrow.
    • ax (number)
      default: -10
      Sets the x component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from right to left (left to right)
    • ay (number)
      default: -30
      Sets the y component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom)
    • xref (enumerated: 'paper' | '/^x([2-9]|[1-9][0-9]+)?$/' )
      Sets the annotation's x coordinate axis. If set to an x axis id (e.g. 'x' or 'x2'), the `x` position refers to an x coordinate If set to 'paper', the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side.
    • x (number)
      Sets the annotation's x position. Note that dates and categories are converted to numbers.
    • xanchor (enumerated: 'auto' | 'left' | 'center' | 'right' )
      default: 'auto'
      Sets the annotation's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the annotation. For example, if `x` is set to 1, `xref` to 'paper' and `xanchor` to 'right' then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If 'auto', the anchor is equivalent to 'center' for data-referenced annotations whereas for paper-referenced, the anchor picked corresponds to the closest side.
    • yref (enumerated: 'paper' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      Sets the annotation's y coordinate axis. If set to an y axis id (e.g. 'y' or 'y2'), the `y` position refers to an y coordinate If set to 'paper', the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top).
    • y (number)
      Sets the annotation's y position. Note that dates and categories are converted to numbers.
    • yanchor (enumerated: 'auto' | 'top' | 'middle' | 'bottom' )
      default: 'auto'
      Sets the annotation's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the annotation. For example, if `y` is set to 1, `yref` to 'paper' and `yanchor` to 'top' then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If 'auto', the anchor is equivalent to 'middle' for data-referenced annotations whereas for paper-referenced, the anchor picked corresponds to the closest side.
    • _deprecated
  • shapes (cell array of structs)
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the opacity of the shape.
    • line (struct)
      • color (color)
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 2
        Sets the line width (in px).
      • dash (string)
        default: 'solid'
        Sets the style of the lines.
    • fillcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color filling the shape's interior.
    • type (enumerated: 'circle' | 'rect' | 'path' | 'line' )
      Specifies the shape type to be drawn. If 'line', a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) If 'circle', a circle is drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) If 'rect', a rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) If 'path', draw a custom SVG path using `path`.
    • xref (enumerated: 'paper' | '/^x([2-9]|[1-9][0-9]+)?$/' )
      Sets the shape's x coordinate axis. If set to an x axis id (e.g. 'x' or 'x2'), the `x` position refers to an x coordinate If set to 'paper', the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where '0' ('1') corresponds to the left (right) side.
    • x0 (any)
      Sets the shape's starting x position. See `type` for more info.
    • x1 (any)
      Sets the shape's end x position. See `type` for more info.
    • yref (enumerated: 'paper' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      Sets the annotation's y coordinate axis. If set to an y axis id (e.g. 'y' or 'y2'), the `y` position refers to an y coordinate If set to 'paper', the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where '0' ('1') corresponds to the bottom (top).
    • y0 (any)
      Sets the shape's starting y position. See `type` for more info.
    • y1 (any)
      Sets the shape's end y position. See `type` for more info.
    • path (string)
      default: 'For `type` 'path' - a valid SVG path but with the pixel values replaced by data values. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained "polybezier" commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can't use either to separate date from time parts. Therefore we'll use underscore for this purpose: 2015-02-21_13:45:56.789'
  • radialaxis (struct)
    • range (cell array)
      Defines the start and end point of this radial axis.
    • domain (cell array)
      default: [0, 1]
      Polar chart subplots are not supported yet. This key has currently no effect.
    • orientation (number)
      Sets the orientation (an angle with respect to the origin) of the radial axis.
    • showline (boolean)
      Determines whether or not the line bounding this radial axis will be shown on the figure.
    • showticklabels (boolean)
      Determines whether or not the radial axis ticks will feature tick labels.
    • tickorientation (enumerated: 'horizontal' | 'vertical' )
      Sets the orientation (from the paper perspective) of the radial axis tick labels.
    • ticklen (number greater than or equal to 0)
      Sets the length of the tick lines on this radial axis.
    • tickcolor (color)
      Sets the color of the tick lines on this radial axis.
    • ticksuffix (string)
      Sets the length of the tick lines on this radial axis.
    • endpadding (number)
    • visible (boolean)
      Determines whether or not this axis will be visible.
  • angularaxis (struct)
    • range (cell array)
      Defines the start and end point of this angular axis.
    • domain (cell array)
      default: [0, 1]
      Polar chart subplots are not supported yet. This key has currently no effect.
    • showline (boolean)
      Determines whether or not the line bounding this angular axis will be shown on the figure.
    • showticklabels (boolean)
      Determines whether or not the angular axis ticks will feature tick labels.
    • tickorientation (enumerated: 'horizontal' | 'vertical' )
      Sets the orientation (from the paper perspective) of the angular axis tick labels.
    • ticklen (number greater than or equal to 0)
      Sets the length of the tick lines on this angular axis.
    • tickcolor (color)
      Sets the color of the tick lines on this angular axis.
    • ticksuffix (string)
      Sets the length of the tick lines on this angular axis.
    • endpadding (number)
    • visible (boolean)
      Determines whether or not this axis will be visible.
  • direction (enumerated: 'clockwise' | 'counterclockwise' )
    For polar plots only. Sets the direction corresponding to positive angles.
  • orientation (angle)
    For polar plots only. Rotates the entire polar by the given angle.

scatter

bar

box

heatmap

histogram

histogram2d

pie

contour

histogram2dcontour

scatter3d

surface

mesh3d

scattergeo

choropleth

area

layout

scatter
A scatter trace is a struct inside fig.data which has type equal to 'scatter'. This section lists all of the valid keys that a scatter struct can contain.

The data visualized as scatter point or lines is set in `x` and `y` Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.

  • type ('scatter')
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • mode (flaglist)
    flags: 'lines' | 'markers' | 'text'
    extras: 'none'
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.
  • line (struct)
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • shape (enumerated: 'linear' | 'spline' | 'hv' | 'vh' | 'hvh' | 'vhv' )
      default: 'linear'
      Determines the line shape. With 'spline' the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Has only an effect if `shape` is set to 'spline' Sets the amount of smoothing. '0' corresponds to no smoothing (equivalent to a 'linear' shape).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • fill (enumerated: 'none' | 'tozeroy' | 'tozerox' | 'tonexty' | 'tonextx' )
    default: 'none'
    Sets the area to fill with a solid color. Use with `fillcolor`.
  • fillcolor (color)
    Sets the fill color.
  • marker (struct)
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets the marker color.
    • maxdisplayed (number greater than or equal to 0)
      default: 0
      Sets a maximum number of points to be drawn on the graph. '0' corresponds to no limit.
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'middle center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont (struct)
    Sets the text font.
    • family (string)
    • size (number greater than or equal to 1)
    • color (color)
    • familysrc (string)
      Sets the source reference on plot.ly for family .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .

bar
A bar trace is a struct inside fig.data which has type equal to 'bar'. This section lists all of the valid keys that a bar struct can contain.

The data visualized by the span of the bars is set in `y` if `orientation` is set th 'v' (the default) and the labels are set in `x`. By setting `orientation` to 'h', the roles are interchanged.

  • type ('bar')
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • marker (struct)
    • color (color)
      Sets the marker color.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • _deprecated
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .

box
A box trace is a struct inside fig.data which has type equal to 'box'. This section lists all of the valid keys that a box struct can contain.

In vertical (horizontal) box plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one box per distinct x (y) value is drawn If no `x` (`y`) cell array is provided, a single box is drawn. That box position is then positioned with with `name` or with `x0` (`y0`) if provided. Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2) is marked by a line inside the box. By default, the whiskers correspond to the box' edges +/- 1.5 times the interquartile range (IQR = Q3-Q1), see 'boxpoints' for other options.

  • type ('box')
  • y (array)
    Sets the y sample data or coordinates. See overview for more info.
  • x (array)
    Sets the x sample data or coordinates. See overview for more info.
  • x0 (any)
    Sets the x coordinate of the box. See overview for more info.
  • y0 (any)
    Sets the y coordinate of the box. See overview for more info.
  • whiskerwidth (number between or equal to 0 and 1)
    default: 0.5
    Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
  • boxpoints (enumerated: 'all' | 'outliers' | 'suspectedoutliers' | false )
    default: 'outliers'
    If 'outliers', only the sample points lying outside the whiskers are shown If 'suspectedoutliers', the outlier points are shown and points either less than 4'Q1-3'Q3 or greater than 4'Q3-3'Q1 are highlighted (see `outliercolor`) If 'all', all sample points are shown If 'false', only the box(es) are shown with no sample points
  • boxmean (enumerated: true | 'sd' | false )
    If 'true', the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If 'sd' the standard deviation is also drawn.
  • jitter (number between or equal to 0 and 1)
    Sets the amount of jitter in the sample points drawn. If '0', the sample points align along the distribution axis. If '1', the sample points are drawn in a random jitter of width equal to the width of the box(es).
  • pointpos (number between or equal to -2 and 2)
    Sets the position of the sample points in relation to the box(es). If '0', the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the box(es). If 'v' ('h'), the distribution is visualized along the vertical (horizontal).
  • marker (struct)
    • outliercolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of the outlier sample points.
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets the marker color.
    • line (struct)
      • color (color)
        default: '#444'
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • outliercolor (color)
        Sets the border line color of the outlier sample points.
      • outlierwidth (number greater than or equal to 0)
        default: 1
        Sets the border line width (in px) of the outlier sample points.
  • line (struct)
    • color (color)
      Sets the color of line bounding the box(es).
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the box(es).
  • fillcolor (color)
    Sets the fill color.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • xsrc (string)
    Sets the source reference on plot.ly for x .

heatmap
A heatmap trace is a struct inside fig.data which has type equal to 'heatmap'. This section lists all of the valid keys that a heatmap struct can contain.

The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a matrix of values (ragged or not) or a 1D array of values. In the case where `z` is a matrix, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D cell array, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets.

  • type ('heatmap')
  • z (array)
    Sets the z data.
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

histogram
A histogram trace is a struct inside fig.data which has type equal to 'histogram'. This section lists all of the valid keys that a histogram struct can contain.

The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided.

  • type ('histogram')
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • marker (struct)
    • color (array)
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • z (array)
    Sets the aggregation data.
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins (struct)
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins (struct)
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each y axis bin.
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • _deprecated
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .
  • zsrc (string)
    Sets the source reference on plot.ly for z .

histogram2d
A histogram2d trace is a struct inside fig.data which has type equal to 'histogram2d'. This section lists all of the valid keys that a histogram2d struct can contain.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a heatmap.

  • type ('histogram2d')
  • z (array)
    Sets the aggregation data.
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • marker (struct)
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins (struct)
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins (struct)
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each y axis bin.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

pie
A pie trace is a struct inside fig.data which has type equal to 'pie'. This section lists all of the valid keys that a pie struct can contain.

A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`

  • type ('pie')
  • labels (array)
    Sets the sector labels.
  • label0 (number)
    default: 0
    Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
  • dlabel (number)
    default: 1
    Sets the label step. See `label0` for more info.
  • marker (struct)
    • colors (array)
      Sets the color of each sector of this pie chart. If not specified, the default trace color set is used to pick the sector colors.
    • line (struct)
      • color (color)
        default: '#444'
        Sets the color of the line enclosing each sector.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the line enclosing each sector.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorssrc (string)
      Sets the source reference on plot.ly for colors .
  • text (array)
    Sets text elements associated with each sector.
  • scalegroup (string)
    default: ''
    If there are multiple pies that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
  • textinfo (flaglist)
    flags: 'label' | 'text' | 'value' | 'percent'
    extras: 'none'
    examples: 'label', 'text', 'label+text', 'label+text+value', 'none'
    Determines which trace information appear on the graph.
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • textposition (enumerated: 'inside' | 'outside' | 'auto' | 'none' )
    default: 'auto'
    Specifies the location of the `textinfo`.
  • textfont (struct)
    Sets the font used for `textinfo`.
  • insidetextfont (struct)
    Sets the font used for `textinfo` lying inside the pie.
  • outsidetextfont (struct)
    Sets the font used for `textinfo` lying outside the pie.
  • domain (struct)
    • x (cell array)
      default: [0, 1]
      Sets the horizontal domain of this pie trace (in plot fraction).
    • y (cell array)
      default: [0, 1]
      Sets the vertical domain of this pie trace (in plot fraction).
  • hole (number between or equal to 0 and 1)
    default: 0
    Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.
  • sort (boolean)
    default: true
    Determines whether or not the sectors of reordered from largest to smallest.
  • direction (enumerated: 'clockwise' | 'counterclockwise' )
    default: 'counterclockwise'
    Specifies the direction at which succeeding sectors follow one another.
  • rotation (number between or equal to -360 and 360)
    default: 0
    Instead of the first slice starting at 12 o'clock, rotate to some other angle.
  • pull (number between or equal to 0 and 1)
    default: 0
    Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • labelssrc (string)
    Sets the source reference on plot.ly for labels .
  • valuessrc (string)
    Sets the source reference on plot.ly for values .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .
  • pullsrc (string)
    Sets the source reference on plot.ly for pull .

contour
A contour trace is a struct inside fig.data which has type equal to 'contour'. This section lists all of the valid keys that a contour struct can contain.

The data from which contour lines are computed is set in `z`. Data in `z` must be a matrix of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto-generated). By setting `transpose` to 'true', the above behavior is flipped.

  • type ('contour')
  • z (array)
    Sets the z data.
  • x (array)
    Sets the x coordinates.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • autocontour (boolean)
    default: true
    Determines whether of not the contour level attributes at picked by an algorithm. If 'true', the number of contour levels can be set in `ncontours`. If 'false', set the contour level attributes in `contours`.
  • ncontours (integer)
    default: 0
    Sets the number of contour levels.
  • contours (struct)
    • start (number)
      Sets the starting contour level value.
    • end (number)
      Sets the end contour level value.
    • size (number)
      Sets the step between each contour level.
    • coloring (enumerated: 'fill' | 'heatmap' | 'lines' | 'none' )
      default: 'fill'
      Determines the coloring method showing the contour values. If 'fill', coloring is done evenly between each contour level If 'heatmap', a heatmap gradient is coloring is applied between each contour level. If 'lines', coloring is done on the contour lines. If 'none', no coloring is applied on this trace.
    • showlines (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has only an effect if `contours.coloring` is set to 'fill'.
  • line (struct)
    • color (color)
      Sets the color of the contour level. Has no if `contours.coloring` is set to 'lines'.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where '0' corresponds to no smoothing.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

histogram2dcontour
A histogram2dcontour trace is a struct inside fig.data which has type equal to 'histogram2dcontour'. This section lists all of the valid keys that a histogram2dcontour struct can contain.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot.

  • type ('histogram2dcontour')
  • z (array)
    Sets the aggregation data.
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (any)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (any)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • marker (struct)
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins (struct)
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins (struct)
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (any)
      default: 1
      Sets the step in-between value each y axis bin.
  • autocontour (boolean)
    default: true
    Determines whether of not the contour level attributes at picked by an algorithm. If 'true', the number of contour levels can be set in `ncontours`. If 'false', set the contour level attributes in `contours`.
  • ncontours (integer)
    default: 0
    Sets the number of contour levels.
  • contours (struct)
    • start (number)
      Sets the starting contour level value.
    • end (number)
      Sets the end contour level value.
    • size (number)
      Sets the step between each contour level.
    • coloring (enumerated: 'fill' | 'heatmap' | 'lines' | 'none' )
      default: 'fill'
      Determines the coloring method showing the contour values. If 'fill', coloring is done evenly between each contour level If 'heatmap', a heatmap gradient is coloring is applied between each contour level. If 'lines', coloring is done on the contour lines. If 'none', no coloring is applied on this trace.
    • showlines (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has only an effect if `contours.coloring` is set to 'fill'.
  • line (struct)
    • color (color)
      Sets the color of the contour level. Has no if `contours.coloring` is set to 'lines'.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where '0' corresponds to no smoothing.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

scatter3d
A scatter3d trace is a struct inside fig.data which has type equal to 'scatter3d'. This section lists all of the valid keys that a scatter3d struct can contain.

The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.

  • type ('scatter3d')
  • x (array)
    Sets the x coordinates.
  • y (array)
    Sets the y coordinates.
  • z (array)
    Sets the z coordinates.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates.
  • mode (flaglist)
    flags: 'lines' | 'markers' | 'text'
    default: lines+markers
    extras: 'none'
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.
  • surfaceaxis (enumerated: '-1' | '0' | '1' | '2' )
    default: '-1'
    If '-1', the scatter points are not fill with a surface If '0', '1', '2', the scatter points are filled with a Delaunay surface about the x, y, z respectively.
  • surfacecolor (color)
    Sets the surface fill color.
  • projection (struct)
    • x (struct)
      • show (boolean)
        Sets whether or not projections are shown along the x axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • y (struct)
      • show (boolean)
        Sets whether or not projections are shown along the y axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • z (struct)
      • show (boolean)
        Sets whether or not projections are shown along the z axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
  • line (struct)
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
  • marker (struct)
    • color (color)
      Sets the marker color.
    • symbol (enumerated: 'circle' | 'circle-open' | 'square' | 'square-open' | 'diamond' | 'diamond-open' | 'cross' | 'x' )
      default: 'circle'
      Sets the marker symbol type.
    • size (number greater than or equal to 0)
      default: 8
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'top center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont (struct)
    Sets the text font.
    • family (string)
    • size (number greater than or equal to 1)
    • color (color)
    • familysrc (string)
      Sets the source reference on plot.ly for family .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • error_x (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_y (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • error_z (struct)
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • _deprecated
    • arraysrc (string)
      Sets the source reference on plot.ly for array .
    • arrayminussrc (string)
      Sets the source reference on plot.ly for arrayminus .
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .

surface
A surface trace is a struct inside fig.data which has type equal to 'surface'. This section lists all of the valid keys that a surface struct can contain.

The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a matrix. Coordinates in `x` and `y` can either be 1D cell arrays or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step.

  • type ('surface')
  • z (array)
    Sets the z coordinates.
  • x (array)
    Sets the x coordinates.
  • y (array)
    Sets the y coordinates.
  • text (array)
    Sets the text elements associated with each z value.
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • contours (struct)
    • x (struct)
      • show (boolean)
        Sets whether or not dynamic contours are shown along the x axis
      • project (struct)
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
    • y (struct)
      • show (boolean)
        Sets whether or not dynamic contours are shown along the y axis
      • project (struct)
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
    • z (struct)
      • show (boolean)
        Sets whether or not dynamic contours are shown along the z axis
      • project (struct)
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
  • hidesurface (boolean)
  • lighting (struct)
    • ambient (number between or equal to 0 and 1)
      default: 0.8
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
    • specular (number between or equal to 0 and 2)
      default: 0.05
    • roughness (number between or equal to 0 and 1)
      default: 0.5
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

mesh3d
A mesh3d trace is a struct inside fig.data which has type equal to 'mesh3d'. This section lists all of the valid keys that a mesh3d struct can contain.



  • type ('mesh3d')
  • x (array)
  • y (array)
  • z (array)
  • i (array)
  • j (array)
  • k (array)
  • delaunayaxis (enumerated: 'x' | 'y' | 'z' )
    default: 'z'
  • alphahull (number)
    default: -1
  • intensity (array)
  • color (color)
  • vertexcolor (array)
  • facecolor (array)
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • flatshading (boolean)
  • contour (struct)
    • show (boolean)
    • color (color)
      default: '#000'
    • width (number between or equal to 1 and 16)
      default: 2
  • colorscale (colorscale)
    Sets the colorscale.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • lighting (struct)
    • ambient (number between or equal to 0 and 1)
      default: 0.8
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
    • specular (number between or equal to 0 and 2)
      default: 0.05
    • roughness (number between or equal to 0 and 1)
      default: 0.5
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • xsrc (string)
    Sets the source reference on plot.ly for x .
  • ysrc (string)
    Sets the source reference on plot.ly for y .
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • isrc (string)
    Sets the source reference on plot.ly for i .
  • jsrc (string)
    Sets the source reference on plot.ly for j .
  • ksrc (string)
    Sets the source reference on plot.ly for k .
  • intensitysrc (string)
    Sets the source reference on plot.ly for intensity .
  • vertexcolorsrc (string)
    Sets the source reference on plot.ly for vertexcolor .
  • facecolorsrc (string)
    Sets the source reference on plot.ly for facecolor .

scattergeo
A scattergeo trace is a struct inside fig.data which has type equal to 'scattergeo'. This section lists all of the valid keys that a scattergeo struct can contain.

The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in `lon` and `lat` respectively or by geographic location IDs or names in `locations`.

  • type ('scattergeo')
  • lon (array)
    Sets the longitude coordinates (in degrees East).
  • lat (array)
    Sets the latitude coordinates (in degrees North).
  • locations (array)
    Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.
  • locationmode (enumerated: 'ISO-3' | 'USA-states' | 'country names' )
    default: 'ISO-3'
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • mode (flaglist)
    flags: 'lines' | 'markers' | 'text'
    default: markers
    extras: 'none'
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.
  • text (string)
    default: ''
    Sets text elements associated with each (lon,lat) pair. or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates.
  • line (struct)
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines.
  • marker (struct)
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • color (color)
      Sets the marker color.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.color.line` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.color.line` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.color.line` is set to a numerical array. Reverses the colorscale.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
    • colorbar (struct)
      • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
        default: 'right'
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont (struct)
        Sets this color bar's title font.
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • textfont (struct)
    Sets the text font.
    • family (string)
    • size (number greater than or equal to 1)
    • color (color)
    • familysrc (string)
      Sets the source reference on plot.ly for family .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'middle center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • geo (geoid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If 'geo' (the default value), the geospatial coordinates refer to `layout.geo`. If 'geo2', the geospatial coordinates refer to `layout.geo2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • lonsrc (string)
    Sets the source reference on plot.ly for lon .
  • latsrc (string)
    Sets the source reference on plot.ly for lat .
  • locationssrc (string)
    Sets the source reference on plot.ly for locations .
  • textsrc (string)
    Sets the source reference on plot.ly for text .
  • textpositionsrc (string)
    Sets the source reference on plot.ly for textposition .

choropleth
A choropleth trace is a struct inside fig.data which has type equal to 'choropleth'. This section lists all of the valid keys that a choropleth struct can contain.

The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`.

  • type ('choropleth')
  • locations (array)
    Sets the coordinates via location IDs or names. See `locationmode` for more info.
  • locationmode (enumerated: 'ISO-3' | 'USA-states' | 'country names' )
    default: 'ISO-3'
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • z (array)
    Sets the color values.
  • text (array)
    Sets the text elements associated with each location.
  • marker (struct)
    • line (struct)
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc (string)
        Sets the source reference on plot.ly for color .
      • widthsrc (string)
        Sets the source reference on plot.ly for width .
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    default: true
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • colorbar (struct)
    • orient (enumerated: 'left' | 'right' | 'top' | 'bottom' )
      default: 'right'
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont (struct)
      Sets this color bar's title font.
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • geo (geoid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If 'geo' (the default value), the geospatial coordinates refer to `layout.geo`. If 'geo2', the geospatial coordinates refer to `layout.geo2`, and so on.
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • locationssrc (string)
    Sets the source reference on plot.ly for locations .
  • zsrc (string)
    Sets the source reference on plot.ly for z .
  • textsrc (string)
    Sets the source reference on plot.ly for text .

area
A area trace is a struct inside fig.data which has type equal to 'area'. This section lists all of the valid keys that a area struct can contain.



  • type ('area')
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • marker (struct)
    • color (color)
      Sets the marker color.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorsrc (string)
      Sets the source reference on plot.ly for color .
    • sizesrc (string)
      Sets the source reference on plot.ly for size .
    • symbolsrc (string)
      Sets the source reference on plot.ly for symbol .
    • opacitysrc (string)
      Sets the source reference on plot.ly for opacity .
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • uid (string)
    default: ''
  • hoverinfo (flaglist)
    flags: 'x' | 'y' | 'z' | 'text' | 'name'
    default: all
    extras: 'all' | 'none'
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    Determines which trace information appear on hover.
  • stream (struct)
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • rsrc (string)
    Sets the source reference on plot.ly for r .
  • tsrc (string)
    Sets the source reference on plot.ly for t .

layout
  • font (struct)
    Sets the global font. Note that fonts used in traces and other layout components inherit from the global font.
    • family (string)
      default: '"Open sans", verdana, arial, sans-serif'
    • size (number greater than or equal to 1)
      default: 12
    • color (color)
      default: '#444'
  • title (string)
    default: 'Click to enter Plot title'
    Sets the plot's title.
  • titlefont (struct)
    Sets the title font.
  • autosize (enumerated: true | false | 'initial' )
    Determines whether or not the dimensions of the figure are computed as a function of the display size.
  • width (number greater than or equal to 10)
    default: 700
    Sets the plot's width (in px).
  • height (number greater than or equal to 10)
    default: 450
    Sets the plot's height (in px).
  • margin (struct)
    • l (number greater than or equal to 0)
      default: 80
      Sets the left margin (in px).
    • r (number greater than or equal to 0)
      default: 80
      Sets the right margin (in px).
    • t (number greater than or equal to 0)
      default: 100
      Sets the top margin (in px).
    • b (number greater than or equal to 0)
      default: 80
      Sets the bottom margin (in px).
    • pad (number greater than or equal to 0)
      default: 0
      Sets the amount of padding (in px) between the plotting area and the axis lines
    • autoexpand (boolean)
      default: true
  • paper_bgcolor (color)
    default: '#fff'
    Sets the color of paper where the graph is drawn.
  • plot_bgcolor (color)
    default: '#fff'
    Sets the color of plotting area in-between x and y axes.
  • separators (string)
    default: '.,'
    Sets the decimal and thousand separators. For example, '. ' puts a '.' before decimals and a space between thousands.
  • hidesources (boolean)
    Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the plotly cloud.
  • smith (enumerated: false )
  • showlegend (boolean)
    Determines whether or not a legend is drawn.
  • dragmode (enumerated: 'zoom' | 'pan' | 'orbit' | 'turntable' )
    Determines the mode of drag interactions.
  • hovermode (enumerated: 'x' | 'y' | 'closest' | false )
    Determines the mode of hover interactions.
  • xaxis (struct)
    • title (string)
      Sets the title of this axis.
    • titlefont (struct)
      Sets this axis' title font.
    • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
      default: '-'
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange (enumerated: true | false | 'reversed' )
      default: true
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
    • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
      default: 'normal'
      If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
    • range (cell array)
      Sets the range of this axis.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
      Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • hoverformat (string)
      default: ''
      Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: '#444'
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
    • gridcolor (color)
      default: '#eee'
      Sets the color of the grid lines.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • zeroline (boolean)
      Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
    • zerolinecolor (color)
      default: '#444'
      Sets the line color of the zero line.
    • zerolinewidth (number)
      default: 1
      Sets the width (in px) of the zero line.
    • anchor (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set to an opposite-letter axis id (e.g. `xaxis2`, `yaxis`), this axis is bound to the corresponding opposite-letter axis. If set to 'free', this axis' position is determined by `position`.
    • side (enumerated: 'top' | 'bottom' | 'left' | 'right' )
      Determines whether a x (y) axis is positioned at the 'bottom' ('left') or 'top' ('right') of the plotting area.
    • overlaying (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis. If 'false', this axis does not overlay any same-letter axes.
    • domain (cell array)
      default: [0, 1]
      Sets the domain of this axis (in plot fraction).
    • position (number between or equal to 0 and 1)
      default: 0
      Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to 'free'.
    • _deprecated
    • _isSubplotObj
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • yaxis (struct)
    • title (string)
      Sets the title of this axis.
    • titlefont (struct)
      Sets this axis' title font.
    • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
      default: '-'
      Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
    • autorange (enumerated: true | false | 'reversed' )
      default: true
      Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
    • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
      default: 'normal'
      If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
    • range (cell array)
      Sets the range of this axis.
    • fixedrange (boolean)
      Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`.
    • dtick (any)
      default: 1
      Sets the step in-between ticks on this axis
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
      Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont (struct)
      Sets the tick font.
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • hoverformat (string)
      default: ''
      Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • showline (boolean)
      Determines whether or not a line bounding this axis is drawn.
    • linecolor (color)
      default: '#444'
      Sets the axis line color.
    • linewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • showgrid (boolean)
      Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
    • gridcolor (color)
      default: '#eee'
      Sets the color of the grid lines.
    • gridwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the grid lines.
    • zeroline (boolean)
      Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
    • zerolinecolor (color)
      default: '#444'
      Sets the line color of the zero line.
    • zerolinewidth (number)
      default: 1
      Sets the width (in px) of the zero line.
    • anchor (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set to an opposite-letter axis id (e.g. `xaxis2`, `yaxis`), this axis is bound to the corresponding opposite-letter axis. If set to 'free', this axis' position is determined by `position`.
    • side (enumerated: 'top' | 'bottom' | 'left' | 'right' )
      Determines whether a x (y) axis is positioned at the 'bottom' ('left') or 'top' ('right') of the plotting area.
    • overlaying (enumerated: 'free' | '/^x([2-9]|[1-9][0-9]+)?$/' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis. If 'false', this axis does not overlay any same-letter axes.
    • domain (cell array)
      default: [0, 1]
      Sets the domain of this axis (in plot fraction).
    • position (number between or equal to 0 and 1)
      default: 0
      Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if `anchor` is set to 'free'.
    • _deprecated
    • _isSubplotObj
    • tickvalssrc (string)
      Sets the source reference on plot.ly for tickvals .
    • ticktextsrc (string)
      Sets the source reference on plot.ly for ticktext .
  • scene (struct)
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
    • camera (struct)
      • up (struct)
        Sets the (x,y,z) components of the 'up' camera vector. This vector determines the up direction of this scene with respect to the page. The default is '{x: 0, y: 0, z: 1}' which means that the z axis points up.
        • x (number)
          default: 0
        • y (number)
          default: 0
        • z (number)
          default: 1
      • center (struct)
        Sets the (x,y,z) components of the 'center' camera vector This vector determines the translation (x,y,z) space about the center of this scene. By default, there is no such translation.
        • x (number)
          default: 0
        • y (number)
          default: 0
        • z (number)
          default: 0
      • eye (struct)
        Sets the (x,y,z) components of the 'eye' camera vector. This vector determines the view point about the origin of this scene.
        • x (number)
          default: 1.25
        • y (number)
          default: 1.25
        • z (number)
          default: 1.25
    • domain (struct)
      • x (cell array)
        default: [0, 1]
        Sets the horizontal domain of this scene (in plot fraction).
      • y (cell array)
        default: [0, 1]
        Sets the vertical domain of this scene (in plot fraction).
    • aspectmode (enumerated: 'auto' | 'cube' | 'data' | 'manual' )
      default: 'auto'
      If 'cube', this scene's axes are drawn as a cube, regardless of the axes' ranges. If 'data', this scene's axes are drawn in proportion with the axes' ranges. If 'manual', this scene's axes are drawn in proportion with the input of 'aspectratio' (the default behavior if 'aspectratio' is provided). If 'auto', this scene's axes are drawn using the results of 'data' except when one axis is more than four times the size of the two others, where in that case the results of 'cube' are used.
    • aspectratio (struct)
      Sets this scene's axis aspectratio.
      • x (number greater than or equal to 0)
      • y (number greater than or equal to 0)
      • z (number greater than or equal to 0)
    • xaxis (struct)
      • showspikes (boolean)
        default: true
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: true
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: 'rgb(0,0,0)'
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: 'rgba(204, 204, 204, 0.5)'
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: true
        Sets whether or not this axis is labeled
      • title (string)
        Sets the title of this axis.
      • titlefont (struct)
        Sets this axis' title font.
      • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
        default: '-'
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange (enumerated: true | false | 'reversed' )
        default: true
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
      • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
        default: 'normal'
        If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
      • range (cell array)
        Sets the range of this axis.
      • fixedrange (boolean)
        Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • hoverformat (string)
        default: ''
        Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: '#444'
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: 'rgb(204, 204, 204)'
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: '#444'
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • yaxis (struct)
      • showspikes (boolean)
        default: true
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: true
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: 'rgb(0,0,0)'
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: 'rgba(204, 204, 204, 0.5)'
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: true
        Sets whether or not this axis is labeled
      • title (string)
        Sets the title of this axis.
      • titlefont (struct)
        Sets this axis' title font.
      • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
        default: '-'
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange (enumerated: true | false | 'reversed' )
        default: true
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
      • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
        default: 'normal'
        If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
      • range (cell array)
        Sets the range of this axis.
      • fixedrange (boolean)
        Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • hoverformat (string)
        default: ''
        Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: '#444'
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: 'rgb(204, 204, 204)'
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: '#444'
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • zaxis (struct)
      • showspikes (boolean)
        default: true
        Sets whether or not spikes starting from data points to this axis' wall are shown on hover.
      • spikesides (boolean)
        default: true
        Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.
      • spikethickness (number greater than or equal to 0)
        default: 2
        Sets the thickness (in px) of the spikes.
      • spikecolor (color)
        default: 'rgb(0,0,0)'
        Sets the color of the spikes.
      • showbackground (boolean)
        Sets whether or not this axis' wall has a background color.
      • backgroundcolor (color)
        default: 'rgba(204, 204, 204, 0.5)'
        Sets the background color of this axis' wall.
      • showaxeslabels (boolean)
        default: true
        Sets whether or not this axis is labeled
      • title (string)
        Sets the title of this axis.
      • titlefont (struct)
        Sets this axis' title font.
      • type (enumerated: '-' | 'linear' | 'log' | 'date' | 'category' )
        default: '-'
        Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
      • autorange (enumerated: true | false | 'reversed' )
        default: true
        Determines whether or not the range of this axis is computed in relation to the input data. See `rangemode` for more info. If `range` is provided, then `autorange` is set to 'false'.
      • rangemode (enumerated: 'normal' | 'tozero' | 'nonnegative' )
        default: 'normal'
        If 'normal', the range is computed in relation to the extrema of the input data. If 'tozero'`, the range extends to 0, regardless of the input data If 'nonnegative', the range is non-negative, regardless of the input data.
      • range (cell array)
        Sets the range of this axis.
      • fixedrange (boolean)
        Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`.
      • dtick (any)
        default: 1
        Sets the step in-between ticks on this axis
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • mirror (enumerated: true | 'ticks' | false | 'all' | 'allticks' )
        Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If 'true', the axis lines are mirrored. If 'ticks', the axis lines and ticks are mirrored. If 'false', mirroring is disable. If 'all', axis lines are mirrored on all shared-axes subplots. If 'allticks', axis lines and ticks are mirrored on all shared-axes subplots.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont (struct)
        Sets the tick font.
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • hoverformat (string)
        default: ''
        Sets the hover text formatting rule for data values on this axis, using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • showline (boolean)
        Determines whether or not a line bounding this axis is drawn.
      • linecolor (color)
        default: '#444'
        Sets the axis line color.
      • linewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • showgrid (boolean)
        Determines whether or not grid lines are drawn. If 'true', the grid lines are drawn at every tick mark.
      • gridcolor (color)
        default: 'rgb(204, 204, 204)'
        Sets the color of the grid lines.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the grid lines.
      • zeroline (boolean)
        Determines whether or not a line is drawn at along the 0 value of this axis. If 'true', the zero line is drawn on top of the grid lines.
      • zerolinecolor (color)
        default: '#444'
        Sets the line color of the zero line.
      • zerolinewidth (number)
        default: 1
        Sets the width (in px) of the zero line.
      • tickvalssrc (string)
        Sets the source reference on plot.ly for tickvals .
      • ticktextsrc (string)
        Sets the source reference on plot.ly for ticktext .
    • _deprecated
    • _isSubplotObj
  • geo (struct)
    • domain (struct)
      • x (cell array)
        default: [0, 1]
        Sets the horizontal domain of this map (in plot fraction).
      • y (cell array)
        default: [0, 1]
        Sets the vertical domain of this map (in plot fraction).
    • resolution (enumerated: '110' | '50' )
      default: '110'
      Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.
    • scope (enumerated: 'world' | 'usa' | 'europe' | 'asia' | 'africa' | 'north america' | 'south america' )
      default: 'world'
      Set the scope of the map.
    • projection (struct)
      • type (enumerated: 'equirectangular' | 'mercator' | 'orthographic' | 'natural earth' | 'kavrayskiy7' | 'miller' | 'robinson' | 'eckert4' | 'azimuthal equal area' | 'azimuthal equidistant' | 'conic equal area' | 'conic conformal' | 'conic equidistant' | 'gnomonic' | 'stereographic' | 'mollweide' | 'hammer' | 'transverse mercator' | 'albers usa' )
        Sets the projection type.
      • rotation (struct)
        • lon (number)
          Rotates the map along parallels (in degrees East).
        • lat (number)
          Rotates the map along meridians (in degrees North).
        • roll (number)
          Roll the map (in degrees) For example, a roll of '180' makes the map appear upside down.
      • parallels (cell array)
        For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere.
      • scale (number between or equal to 0 and 10)
        default: 1
        Zooms in or out on the map view.
    • showcoastlines (boolean)
      Sets whether or not the coastlines are drawn.
    • coastlinecolor (color)
      default: '#444'
      Sets the coastline color.
    • coastlinewidth (number greater than or equal to 0)
      default: 1
      Sets the coastline stroke width (in px).
    • showland (boolean)
      Sets whether or not land masses are filled in color.
    • landcolor (color)
      default: '#F0DC82'
      Sets the land mass color.
    • showocean (boolean)
      Sets whether or not oceans are filled in color.
    • oceancolor (color)
      default: '#3399FF'
      Sets the ocean color
    • showlakes (boolean)
      Sets whether or not lakes are drawn.
    • lakecolor (color)
      default: '#3399FF'
      Sets the color of the lakes.
    • showrivers (boolean)
      Sets whether or not rivers are drawn.
    • rivercolor (color)
      default: '#3399FF'
      Sets color of the rivers.
    • riverwidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the rivers.
    • showcountries (boolean)
      Sets whether or not country boundaries are drawn.
    • countrycolor (color)
      default: '#444'
      Sets line color of the country boundaries.
    • countrywidth (number greater than or equal to 0)
      default: 1
      Sets line width (in px) of the country boundaries.
    • showsubunits (boolean)
      Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.
    • subunitcolor (color)
      default: '#444'
      Sets the color of the subunits boundaries.
    • subunitwidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the subunits boundaries.
    • showframe (boolean)
      Sets whether or not a frame is drawn around the map.
    • framecolor (color)
      default: '#444'
      Sets the color the frame.
    • framewidth (number greater than or equal to 0)
      default: 1
      Sets the stroke width (in px) of the frame.
    • bgcolor (color)
      default: '#fff'
      Set the background color of the map
    • lonaxis (struct)
      • range (cell array)
        Sets the range of this axis (in degrees).
      • showgrid (boolean)
        Sets whether or not graticule are shown on the map.
      • tick0 (number)
        Sets the graticule's starting tick longitude/latitude.
      • dtick (number)
        Sets the graticule's longitude/latitude tick step.
      • gridcolor (color)
        default: '#eee'
        Sets the graticule's stroke color.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the graticule's stroke width (in px).
    • lataxis (struct)
      • range (cell array)
        Sets the range of this axis (in degrees).
      • showgrid (boolean)
        Sets whether or not graticule are shown on the map.
      • tick0 (number)
        Sets the graticule's starting tick longitude/latitude.
      • dtick (number)
        Sets the graticule's longitude/latitude tick step.
      • gridcolor (color)
        default: '#eee'
        Sets the graticule's stroke color.
      • gridwidth (number greater than or equal to 0)
        default: 1
        Sets the graticule's stroke width (in px).
    • _isSubplotObj
  • legend (struct)
    • bgcolor (color)
      Sets the legend background color.
    • bordercolor (color)
      default: '#444'
      Sets the color of the border enclosing the legend.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) of the border enclosing the legend.
    • font (struct)
      Sets the font used to text the legend items.
    • traceorder (flaglist)
      flags: 'reversed' | 'grouped'
      extras: 'normal'
      examples: 'reversed', 'grouped', 'reversed+grouped', 'normal'
      Determines the order at which the legend items are displayed. If 'normal', the items are displayed top-to-bottom in the same order as the input data. If 'reversed', the items are displayed in the opposite order as 'normal'. If 'grouped', the items are displayed in groups (when a trace `legendgroup` is provided). if 'grouped+reversed', the items are displayed in the opposite order as 'grouped'.
    • tracegroupgap (number greater than or equal to 0)
      default: 10
      Sets the amount of vertical space (in px) between legend groups.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position (in normalized coordinates) of the legend.
    • xanchor (enumerated: 'auto' | 'left' | 'center' | 'right' )
      default: 'left'
      Sets the legend's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the legend.
    • y (number between or equal to -2 and 3)
      default: 1
      Sets the y position (in normalized coordinates) of the legend.
    • yanchor (enumerated: 'auto' | 'top' | 'middle' | 'bottom' )
      default: 'auto'
      Sets the legend's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the legend.
  • annotations (cell array of structs)
    • text (string)
      Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.
    • textangle (angle)
      default: 0
      Sets the angle at which the `text` is drawn with respect to the horizontal.
    • font (struct)
      Sets the annotation text font.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the opacity of the annotation (text + arrow).
    • align (enumerated: 'left' | 'center' | 'right' )
      default: 'center'
      Sets the vertical alignment of the `text` with respect to the set `x` and `y` position. Has only an effect if `text` spans more two or more lines (i.e. `text` contains one or more <br> HTML tags).
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the background color of the annotation.
    • bordercolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of the border enclosing the annotation `text`.
    • borderpad (number greater than or equal to 0)
      default: 1
      Sets the padding (in px) between the `text` and the enclosing border.
    • borderwidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the border enclosing the annotation `text`.
    • showarrow (boolean)
      default: true
      Determines whether or not the annotation is drawn with an arrow. If 'true', `text` is placed near the arrow's tail. If 'false', `text` lines up with the `x` and `y` provided.
    • arrowcolor (color)
      Sets the color of the annotation arrow.
    • arrowhead (integer between or equal to 0 and 8)
      default: 1
      Sets the annotation arrow head style.
    • arrowsize (number greater than or equal to 0.3)
      default: 1
      Sets the size (in px) of annotation arrow head.
    • arrowwidth (number greater than or equal to 0.1)
      Sets the width (in px) of annotation arrow.
    • ax (number)
      default: -10
      Sets the x component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from right to left (left to right)
    • ay (number)
      default: -30
      Sets the y component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom)
    • xref (enumerated: 'paper' | '/^x([2-9]|[1-9][0-9]+)?$/' )
      Sets the annotation's x coordinate axis. If set to an x axis id (e.g. 'x' or 'x2'), the `x` position refers to an x coordinate If set to 'paper', the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side.
    • x (number)
      Sets the annotation's x position. Note that dates and categories are converted to numbers.
    • xanchor (enumerated: 'auto' | 'left' | 'center' | 'right' )
      default: 'auto'
      Sets the annotation's horizontal position anchor This anchor binds the `x` position to the 'left', 'center' or 'right' of the annotation. For example, if `x` is set to 1, `xref` to 'paper' and `xanchor` to 'right' then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If 'auto', the anchor is equivalent to 'center' for data-referenced annotations whereas for paper-referenced, the anchor picked corresponds to the closest side.
    • yref (enumerated: 'paper' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      Sets the annotation's y coordinate axis. If set to an y axis id (e.g. 'y' or 'y2'), the `y` position refers to an y coordinate If set to 'paper', the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top).
    • y (number)
      Sets the annotation's y position. Note that dates and categories are converted to numbers.
    • yanchor (enumerated: 'auto' | 'top' | 'middle' | 'bottom' )
      default: 'auto'
      Sets the annotation's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the annotation. For example, if `y` is set to 1, `yref` to 'paper' and `yanchor` to 'top' then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If 'auto', the anchor is equivalent to 'middle' for data-referenced annotations whereas for paper-referenced, the anchor picked corresponds to the closest side.
    • _deprecated
  • shapes (cell array of structs)
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the opacity of the shape.
    • line (struct)
      • color (color)
        Sets the line color.
      • width (number greater than or equal to 0)
        default: 2
        Sets the line width (in px).
      • dash (string)
        default: 'solid'
        Sets the style of the lines.
    • fillcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color filling the shape's interior.
    • type (enumerated: 'circle' | 'rect' | 'path' | 'line' )
      Specifies the shape type to be drawn. If 'line', a line is drawn from (`x0`,`y0`) to (`x1`,`y1`) If 'circle', a circle is drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) If 'rect', a rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) If 'path', draw a custom SVG path using `path`.
    • xref (enumerated: 'paper' | '/^x([2-9]|[1-9][0-9]+)?$/' )
      Sets the shape's x coordinate axis. If set to an x axis id (e.g. 'x' or 'x2'), the `x` position refers to an x coordinate If set to 'paper', the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where '0' ('1') corresponds to the left (right) side.
    • x0 (any)
      Sets the shape's starting x position. See `type` for more info.
    • x1 (any)
      Sets the shape's end x position. See `type` for more info.
    • yref (enumerated: 'paper' | '/^y([2-9]|[1-9][0-9]+)?$/' )
      Sets the annotation's y coordinate axis. If set to an y axis id (e.g. 'y' or 'y2'), the `y` position refers to an y coordinate If set to 'paper', the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where '0' ('1') corresponds to the bottom (top).
    • y0 (any)
      Sets the shape's starting y position. See `type` for more info.
    • y1 (any)
      Sets the shape's end y position. See `type` for more info.
    • path (string)
      default: 'For `type` 'path' - a valid SVG path but with the pixel values replaced by data values. There are a few restrictions / quirks only absolute instructions, not relative. So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs (A) are not allowed because radius rx and ry are relative. In the future we could consider supporting relative commands, but we would have to decide on how to handle date and log axes. Note that even as is, Q and C Bezier paths that are smooth on linear axes may not be smooth on log, and vice versa. no chained "polybezier" commands - specify the segment type for each one. On category axes, values are numbers scaled to the serial numbers of categories because using the categories themselves there would be no way to describe fractional positions On data axes: because space and T are both normal components of path strings, we can't use either to separate date from time parts. Therefore we'll use underscore for this purpose: 2015-02-21_13:45:56.789'
  • radialaxis (struct)
    • range (cell array)
      Defines the start and end point of this radial axis.
    • domain (cell array)
      default: [0, 1]
      Polar chart subplots are not supported yet. This key has currently no effect.
    • orientation (number)
      Sets the orientation (an angle with respect to the origin) of the radial axis.
    • showline (boolean)
      Determines whether or not the line bounding this radial axis will be shown on the figure.
    • showticklabels (boolean)
      Determines whether or not the radial axis ticks will feature tick labels.
    • tickorientation (enumerated: 'horizontal' | 'vertical' )
      Sets the orientation (from the paper perspective) of the radial axis tick labels.
    • ticklen (number greater than or equal to 0)
      Sets the length of the tick lines on this radial axis.
    • tickcolor (color)
      Sets the color of the tick lines on this radial axis.
    • ticksuffix (string)
      Sets the length of the tick lines on this radial axis.
    • endpadding (number)
    • visible (boolean)
      Determines whether or not this axis will be visible.
  • angularaxis (struct)
    • range (cell array)
      Defines the start and end point of this angular axis.
    • domain (cell array)
      default: [0, 1]
      Polar chart subplots are not supported yet. This key has currently no effect.
    • showline (boolean)
      Determines whether or not the line bounding this angular axis will be shown on the figure.
    • showticklabels (boolean)
      Determines whether or not the angular axis ticks will feature tick labels.
    • tickorientation (enumerated: 'horizontal' | 'vertical' )
      Sets the orientation (from the paper perspective) of the angular axis tick labels.
    • ticklen (number greater than or equal to 0)
      Sets the length of the tick lines on this angular axis.
    • tickcolor (color)
      Sets the color of the tick lines on this angular axis.
    • ticksuffix (string)
      Sets the length of the tick lines on this angular axis.
    • endpadding (number)
    • visible (boolean)
      Determines whether or not this axis will be visible.
  • direction (enumerated: 'clockwise' | 'counterclockwise' )
    For polar plots only. Sets the direction corresponding to positive angles.
  • orientation (angle)
    For polar plots only. Rotates the entire polar by the given angle.